package flac import "core:bytes" import "core:crypto/legacy/md5" import "core:fmt" import "core:io" import "core:mem" import "core:os" import "core:time" Error :: union { io.Error, FlacError, } FlacError :: enum { Unable_To_Read_File, Invalid_Signature, Invalid_Sample_Rate, Missing_StreamInfo, Missing_Lead_Out_Track, Invalid_Coefficient_Precision, Metadata_Block_Length_Mismatch, CRC_Mismatch, MD5_Mismatch, Unsupported_BPS, // Remove when implemented Unencoded_BPS_For_Fixed_Subframe_Is_Unsupported, // Remove when implemented Invalid_Residual_Coding_Method, Invalid_Block_Size, Bits_Per_Second_Mismatch, Negative_Coefficient_Bits_To_Shift, } /* Option: `.skip_md5_check` Skips checking the MD5 hash of the decoded sample data. Offers a slight performance increase but will not error if the data is incorrect. `.only_return_picture_data` Returns the embedded picture metadata and encoded pixel data (if available) `.only_return_metadata` includes this. `.only_return_metadata` Returns all metadata of a FLAC stream without decoding the audio data. */ // TODO: Implement these Option :: enum { skip_md5_check, only_return_picture_data, only_return_metadata, } Options :: bit_set[Option] PictureType :: enum u32be { OTHER, FILE_ICON_32x32_PNG, OTHER_FILE_ICON, COVER_FRONT, COVER_BACK, LEAFLET, MEDIA, LEAD_ARTIST, ARTIST, CONDUCTOR, BAND, COMPOSER, LYRICIST, RECORDING_LOCATION, DURING_RECORDING, DURING_PERFORMANCE, VIDEO_SCREEN_CAPTURE, BRIGHT_COLORED_FISH, ILLUSTRATION, ARTIST_LOGO, PUBLISHER_LOGO, } Flac :: struct { // TODO: Sample slice or array, other stuff metadata: Flac_Metadata, samples: []i32, } Flac_Metadata :: struct { // TODO: Picture info and data and other stuff total_samples: u32, bits_per_sample: u8, channels: u8, sample_rate: u32, } #assert(size_of(FlacHeader) == 0x2A) FlacHeader :: struct #packed { magic: u32be, streaminfo_header: u32be, streaminfo: StreamInfoBlock, } decode_subframe :: proc(r: ^Reader, bps: u8, block_size: u16) -> (samples: []i32, err: Error) #no_bounds_check { // TODO: temp allocator?? so we copy the slice of data into the _actual_ sample buffer // Maybe even a static arena with a size of 32MB by default (and configurable using #config) or something // that we then use to allocate from (better perf is the reason because allocating on the heap for every subframe // is probably noticibly slower) subframe_samples := make([]i32, block_size) data := read_byte(r) or_return subframe_type := (data & 0x7E) >> 1 low_3_bits := subframe_type & 7 has_wasted_bits := data & 1 == 1 wasted_bits := 0 if has_wasted_bits { for (read_bit(r) or_return) != 1 { wasted_bits += 1 } wasted_bits += 1 } if subframe_type == 0 { // CONSTANT bits_to_read := int(bps) - wasted_bits sample := i32(read_bits(r, uint(bits_to_read)) or_return) if sample > 0 && (sample >> (uint(bits_to_read) - 1)) & 1 == 1 { sample = -(((~sample) & (i32(pow2(bits_to_read)) - 1)) + 1) } copy(subframe_samples, []i32{sample}) } else if subframe_type == 1 { // VERBATIM // TODO: this will break if bits per sample is anything BUT 16 if bps < 16 || bps > 17 { return nil, .Unsupported_BPS } for sample in 0..> 5) & 1 == 1 { // LPC sample_i := 0 predictor_order := (subframe_type & 0x1F) + 1 bits_to_read := int(bps) - wasted_bits for s in 0.. 0 && (unencoded_warmup_sample >> (uint(bits_to_read) - 1)) & 1 == 1 { unencoded_warmup_sample = -(((~unencoded_warmup_sample) & (i32(pow2(bits_to_read)) - 1)) + 1) } subframe_samples[s] = unencoded_warmup_sample } coeff_precision_minus_one := u8(read_bits(r, 4) or_return) if coeff_precision_minus_one == 0xF { return nil, .Invalid_Coefficient_Precision } coeff_precision := coeff_precision_minus_one + 1 coeff_bits_to_shift := i8(read_bits(r, 5) or_return) // NOTE: This is signed 2's complement so we check the MSB // NOTE: This is apparently supposed to never be a negative number according to the (new?) spec. // TODO: For now we just error if the shift value is negative. I have to find test cases to be sure. if (coeff_bits_to_shift >> (5 - 1)) & 1 == 1 { return nil, .Negative_Coefficient_Bits_To_Shift } coefficients := make([]i32, predictor_order) for i in 0.. 0 && (unencoded_coefficient >> (coeff_precision - 1)) & 1 == 1 { unencoded_coefficient = -(((~unencoded_coefficient) & (i32(pow2(coeff_precision)) - 1)) + 1) } coefficients[i] = unencoded_coefficient } residual_coding_method := ResidualCodingMethod(read_bits(r, 2) or_return) if residual_coding_method != .RICE && residual_coding_method != .RICE2 { return nil, .Invalid_Residual_Coding_Method } partition_order := read_bits(r, 4) or_return partitions := pow2(partition_order) lpc_partitions_loop: for i in 0.. 0 && (residual_sample_value >> (unencoded_bps - 1)) & 1 == 1 { residual_sample_value = -(((~residual_sample_value) & (i32(pow2(unencoded_bps)) - 1)) + 1) } // Restore sample values using the predictor and the residual values predictor_before_shift := 0 c := 0 #reverse for coefficient in coefficients { predictor_before_shift += int(coefficient) * int(subframe_samples[sample_i + c]) c += 1 } predictor := predictor_before_shift >> u8(coeff_bits_to_shift) sample := i32(predictor + int(residual_sample_value)) subframe_samples[sample_i + int(predictor_order)] = sample sample_i += 1 } } else { num_samples := 0 if partition_order == 0 { num_samples = int(block_size - u16(predictor_order)) } else if i != 0 { num_samples = int(block_size / u16(pow2(partition_order))) } else { num_samples = int((block_size / u16(pow2(partition_order))) - u16(predictor_order)) } // // Undo the RICE coding // for s in 0..> u8(coeff_bits_to_shift) sample := predictor + residual_sample_value subframe_samples[sample_i + int(predictor_order)] = i32(sample) sample_i += 1 } } } } else if (subframe_type >> 3) & 1 == 1 && low_3_bits <= 4 { // FIXED sample_i := 0 predictor_order := low_3_bits bits_to_read := int(bps) - wasted_bits // NOTE: samples can be negative for sample in 0.. 0 && (unencoded_warmup_sample >> (uint(bits_to_read) - 1)) & 1 == 1 { unencoded_warmup_sample = -(((~unencoded_warmup_sample) & (i32(pow2(bits_to_read)) - 1)) + 1) } subframe_samples[sample] = unencoded_warmup_sample } residual_coding_method := ResidualCodingMethod(read_bits(r, 2) or_return) if residual_coding_method != .RICE && residual_coding_method != .RICE2 { return nil, .Invalid_Residual_Coding_Method } partition_order := read_bits(r, 4) or_return partitions := pow2(partition_order) fixed_partitions_loop: for i in 0.. 0 && (residual_sample_value >> (unencoded_bps - 1)) & 1 == 1 { residual_sample_value = -(((~residual_sample_value) & (i8(pow2(unencoded_bps)) - 1)) + 1) } } return nil, .Unencoded_BPS_For_Fixed_Subframe_Is_Unsupported // TODO: calculate the actual sample value by using the residual AND the previous sample value // TODO: add the samples to something ?? } else { num_samples := 0 if partition_order == 0 { num_samples = int(block_size - u16(predictor_order)) } else if i != 0 { num_samples = int(block_size / u16(pow2(partition_order))) } else { num_samples = int((block_size / u16(pow2(partition_order))) - u16(predictor_order)) } // // Undo the RICE coding // for s in 0.. ( err: Error, ) #no_bounds_check { // // Frame Header // frame_beginning := r.i //fmt.println("STARTING FRAME", frame_num) //fmt.println("FRAME START AT OFFSET:", r.i) data := read_data(r, u16be) or_return sync_code := data >> 2 blocking_strategy := BlockingStrategy(data & 1) data = read_data(r, u16be) or_return block_size := data >> 12 sample_rate := SampleRate((data >> 8) & 0xF) channel_assignment := ChannelAssignment((data >> 4) & 0xF) sample_size := SampleSize((data >> 1) & 7) coded_num := decode_extended_utf8(r) or_return if blocking_strategy == .VARIABLE { // Sample number of first sample // MUST NOT be larger than 36 bits unencoded or 7 bytes encoded. // MUST be equal to the number of samples preceding the current frame. Otherwise seeking is not possible. // TODO: also write a check for the number of samples so we'll probably keep track of how many samples we decoded // maybe the number of decoded samples can be inferred by the number of frames ?? or just use the length of // the decoded_samples slice. if coded_num > 0x1000000000 { // TODO: Sample number can't be bigger than 36 bits } } else { // Frame number // MUST NOT be larger than 31 bits unencoded or 6 bytes encoded. // MUST be equal to the number of frames preceding the current frame. Otherwise seeking is not possible. // TODO: also write a check for the number of frames so we'll probably keep track of how many frames we decoded. if coded_num > 0x80000000 { // TODO: Frame number cannot be bigger than 31 bits } } actual_block_size: u16be switch block_size { case 1: actual_block_size = 192 case 2..=5: actual_block_size = 576 * auto_cast (pow2(block_size - 2)) case 6: actual_block_size = auto_cast (read_byte(r) or_return) + 1 case 7: actual_block_size = (read_data(r, u16be) or_return) + 1 case 8..=15: actual_block_size = 256 * auto_cast (pow2(block_size - 8)) case: return .Invalid_Block_Size } //if actual_block_size < 15 && !last_frame { // TODO: block sizes less than 16 are only valid for the last frame and MUST NOT be used for any other frame. //} actual_sample_rate_in_Hz: u32 switch sample_rate { case .USE_STREAMINFO: // TODO: ditto for global streaminfo actual_sample_rate_in_Hz = streaminfo_sample_rate case ._88_2kHz: actual_sample_rate_in_Hz = 88200 case ._176_4kHz: actual_sample_rate_in_Hz = 176400 case ._192kHz: actual_sample_rate_in_Hz = 192000 case ._8kHz: actual_sample_rate_in_Hz = 8000 case ._16kHz: actual_sample_rate_in_Hz = 16000 case ._22_05kHz: actual_sample_rate_in_Hz = 22005 case ._24kHz: actual_sample_rate_in_Hz = 24000 case ._32kHz: actual_sample_rate_in_Hz = 32000 case ._44_1kHz: actual_sample_rate_in_Hz = 44100 case ._48kHz: actual_sample_rate_in_Hz = 48000 case ._96kHz: actual_sample_rate_in_Hz = 96000 case .USE_8_BITS_IN_kHz_FROM_HEADER_END: actual_sample_rate_in_Hz = auto_cast (read_byte(r) or_return) * 1000 case .USE_16_BITS_IN_Hz_FROM_HEADER_END: actual_sample_rate_in_Hz = auto_cast (read_data(r, u16be) or_return) case .USE_16_BITS_IN_TENS_OF_Hz_FROM_HEADER_END: actual_sample_rate_in_Hz = auto_cast (read_data(r, u16be) or_return) * 10 case .INVALID: fallthrough case: return .Invalid_Sample_Rate } // TODO: sample rate MUST NOT be 0 if the subframe contains audio. // a sample rate of 0 MAY be used when non-audio is represented. frame_header_end := r.i frame_header_crc := read_byte(r) or_return calculated_header_crc := calculate_crc8(r.s[frame_beginning:frame_header_end]) //fmt.printfln("block size bits: 0b%b", block_size) //fmt.printfln("actual block size: %d sample(s)", actual_block_size) //fmt.println("sample rate bits:", sample_rate) //fmt.printfln("actual sample rate: %dHz", actual_sample_rate_in_Hz) //fmt.println("channel assignment:", channel_assignment) if frame_header_crc != calculated_header_crc { fmt.printfln("Expected frame header CRC: 0x%X, got: 0x%X", frame_header_crc, calculated_header_crc) return .CRC_Mismatch } // // Subframes // bps: u8 switch sample_size { case .USE_STREAMINFO: // TODO: maybe we'll store the streaminfo data in a global flac struct and then retrieve from there // instead of passing a parameter bps = streaminfo_bps case ._8BPS: bps = 8 case ._12BPS: bps = 12 case ._16BPS: bps = 16 case ._20BPS: bps = 20 case ._24BPS: bps = 24 case ._32BPS: bps = 32 } if bps != streaminfo_bps { return .Bits_Per_Second_Mismatch } frame_channels := channels switch channel_assignment { case .MONO: frame_channels = 1 case ._3CHANNELS: frame_channels = 3 case ._4CHANNELS: frame_channels = 4 case ._5CHANNELS: frame_channels = 5 case ._6CHANNELS: frame_channels = 6 case ._7CHANNELS: frame_channels = 7 case ._8CHANNELS: frame_channels = 8 case ._2CHANNELS: fallthrough case .STEREO_LEFT_SIDE: fallthrough case .STEREO_SIDE_RIGHT: fallthrough case .STEREO_MID_SIDE: frame_channels = 2 } if frame_channels != channels { // TODO: warning or error? // we have a faulty file that says it has 5 channels but subframes all say they got 1 // we also have an two uncommon files with increasing and decreasing number of channels // uncommon are supposed to be unusual but still valid FLAC files. why is that first one faulty then??? // so many questions... } // TODO: remember to clean this up subframes := make([][]i32, frame_channels) for i in 0..> 1) right := (mid - side) >> 1 subframes[0][i] = left subframes[1][i] = i32(right) } case .STEREO_SIDE_RIGHT: for i in 0..> 8) & 0xFF) md5.update(&md5_ctx, {first_byte, second_byte}) case 17..=24: first_byte := u8(sample & 0xFF) second_byte := u8((sample >> 8) & 0xFF) third_byte := u8((sample >> 16) & 0xFF) md5.update(&md5_ctx, {first_byte, second_byte, third_byte}) case 25..=32: data := transmute([4]u8)sample md5.update(&md5_ctx, data[:]) case: fmt.println("INVALID BPS") os.exit(1) } } } // // Frame Footer // frame_end := r.i frame_crc := read_data(r, u16be) or_return calculated_frame_crc := calculate_crc16(r.s[frame_beginning:frame_end]) if auto_cast frame_crc != calculated_frame_crc { fmt.eprintfln("Expected frame CRC 0x%X, got 0x%X", frame_crc, calculated_frame_crc) return .CRC_Mismatch } frame_num += 1 return nil } load_from_bytes :: proc(data: []byte, options := Options{}, allocator := context.allocator) -> (err: Error) { r: Reader bytes.reader_init(&r, data) md5.init(&md5_ctx) defer md5.reset(&md5_ctx) header := read_data(&r, FlacHeader) or_return if header.magic != FLAC_MAGIC { return .Invalid_Signature } //fmt.println(header) sample_rate := header.streaminfo.sr_chan_bps_ts >> 44 num_channel_minus_one := (header.streaminfo.sr_chan_bps_ts >> 41) & 7 bits_per_sample_minus_one := (header.streaminfo.sr_chan_bps_ts >> 36) & 0x1F total_samples := header.streaminfo.sr_chan_bps_ts & 0xFFFFFFFFF //fmt.println("sample rate:", sample_rate) //fmt.println("channels:", num_channel_minus_one + 1) //fmt.println("bits per sample:", bits_per_sample_minus_one + 1) //fmt.println("total samples:", total_samples) /*bit_field u32be { last_block: bool | 1, type: BlockType | 7, length: u32be | 24, }*/ streaminfo_header := MetadataBlockHeader { last_block = bool(header.streaminfo_header >> 31), type = BlockType((header.streaminfo_header >> 24) & 0x7F), length = u32(header.streaminfo_header & 0xFFFFFF), } if streaminfo_header.type != .STREAMINFO { return .Missing_StreamInfo } last_block := streaminfo_header.last_block for !last_block { md_block_hdr := read_data(&r, u32be) or_return metadata_block_header := MetadataBlockHeader { last_block = bool(md_block_hdr >> 31), type = BlockType((md_block_hdr >> 24) & 0x7F), length = u32(md_block_hdr & 0xFFFFFF), } //fmt.println("Metadata block", metadata_block_header) last_block = cast(bool)(metadata_block_header.last_block) switch metadata_block_header.type { case .STREAMINFO: // Do nothing, we already parse the mandatory streaminfo metadata case .PADDING: //fmt.printfln("Skipping %d bytes of padding data", metadata_block_header.length) bytes.reader_seek(&r, auto_cast metadata_block_header.length, .Current) case .APPLICATION: //app_id := read_slice(&r, 4) or_return //fmt.println("Found application with ID:", string(app_id)) //fmt.printfln("Skipping %d bytes of application metadata block", metadata_block_header.length) bytes.reader_seek(&r, auto_cast metadata_block_header.length, .Current) // TODO: handle the application data case .SEEKTABLE: // TODO: check for size mismatch? seekpoints := metadata_block_header.length / 18 //fmt.printfln("we have %d seekpoints", seekpoints) for i in 0.. (err: Error) { context.allocator = allocator data, ok := os.read_entire_file(filename) defer delete(data) if ok { return load_from_bytes(data) } else { return .Unable_To_Read_File } }