af_ashowinfo.c

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Stefano Sabatini
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
 
/**
 * @file
 * filter for showing textual audio frame information
 */
 
#include <inttypes.h>
 
#include "libavutil/adler32.h"
#include "libavutil/attributes.h"
#include "libavutil/channel_layout.h"
#include "libavutil/downmix_info.h"
#include "libavutil/iamf.h"
#include "libavutil/mem.h"
#include "libavutil/replaygain.h"
#include "libavutil/timestamp.h"
#include "libavutil/samplefmt.h"
 
#include "libavcodec/defs.h"
 
#include "audio.h"
#include "avfilter.h"
#include "filters.h"
 
typedef struct AShowInfoContext {
    /**
     * Scratch space for individual plane checksums for planar audio
     */
    uint32_t *plane_checksums;
} AShowInfoContext;
 
static av_cold void uninit(AVFilterContext *ctx)
{
    AShowInfoContext *s = ctx->priv;
    av_freep(&s->plane_checksums);
}
 
static void dump_matrixenc(AVFilterContext *ctx, AVFrameSideData *sd)
{
    enum AVMatrixEncoding enc;
 
    av_log(ctx, AV_LOG_INFO, "matrix encoding: ");
 
    if (sd->size < sizeof(enum AVMatrixEncoding)) {
        av_log(ctx, AV_LOG_INFO, "invalid data");
        return;
    }
 
    enc = *(enum AVMatrixEncoding *)sd->data;
    switch (enc) {
    case AV_MATRIX_ENCODING_NONE:           av_log(ctx, AV_LOG_INFO, "none");                break;
    case AV_MATRIX_ENCODING_DOLBY:          av_log(ctx, AV_LOG_INFO, "Dolby Surround");      break;
    case AV_MATRIX_ENCODING_DPLII:          av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic II");  break;
    case AV_MATRIX_ENCODING_DPLIIX:         av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic IIx"); break;
    case AV_MATRIX_ENCODING_DPLIIZ:         av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic IIz"); break;
    case AV_MATRIX_ENCODING_DOLBYEX:        av_log(ctx, AV_LOG_INFO, "Dolby EX");            break;
    case AV_MATRIX_ENCODING_DOLBYHEADPHONE: av_log(ctx, AV_LOG_INFO, "Dolby Headphone");     break;
    default:                                av_log(ctx, AV_LOG_WARNING, "unknown");          break;
    }
}
 
static void dump_downmix(AVFilterContext *ctx, AVFrameSideData *sd)
{
    AVDownmixInfo *di;
 
    av_log(ctx, AV_LOG_INFO, "downmix: ");
    if (sd->size < sizeof(*di)) {
        av_log(ctx, AV_LOG_INFO, "invalid data");
        return;
    }
 
    di = (AVDownmixInfo *)sd->data;
 
    av_log(ctx, AV_LOG_INFO, "preferred downmix type - ");
    switch (di->preferred_downmix_type) {
    case AV_DOWNMIX_TYPE_LORO:    av_log(ctx, AV_LOG_INFO, "Lo/Ro");              break;
    case AV_DOWNMIX_TYPE_LTRT:    av_log(ctx, AV_LOG_INFO, "Lt/Rt");              break;
    case AV_DOWNMIX_TYPE_DPLII:   av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic II"); break;
    default:                      av_log(ctx, AV_LOG_WARNING, "unknown");         break;
    }
 
    av_log(ctx, AV_LOG_INFO, " Mix levels: center %f (%f ltrt) - "
           "surround %f (%f ltrt) - lfe %f",
           di->center_mix_level, di->center_mix_level_ltrt,
           di->surround_mix_level, di->surround_mix_level_ltrt,
           di->lfe_mix_level);
}
 
static const int downmix_type_map[AV_DOWNMIX_TYPE_NB] = {
    [AV_DOWNMIX_TYPE_UNKNOWN] = 0,
    [AV_DOWNMIX_TYPE_LORO]    = 2,
    [AV_DOWNMIX_TYPE_LTRT]    = 2,
    [AV_DOWNMIX_TYPE_DPLII]   = 2,
};
 
static void dump_downmix_matrix(AVFilterContext *ctx, AVFrameSideData *sd, AVChannelLayout *ch_layout)
{
    AVDownmixMatrix *dm = (AVDownmixMatrix *)sd->data;
    char buf[128];
 
    av_log(ctx, AV_LOG_INFO, "downmix matrix: ");
    if (dm->in_ch_count != ch_layout->nb_channels) {
        av_log(ctx, AV_LOG_INFO, "invalid data");
        return;
    }
 
    av_log(ctx, AV_LOG_INFO, "downmix type - ");
    switch (dm->downmix_type) {
    case AV_DOWNMIX_TYPE_LORO:    av_log(ctx, AV_LOG_INFO, "Lo/Ro\n");              break;
    case AV_DOWNMIX_TYPE_LTRT:    av_log(ctx, AV_LOG_INFO, "Lt/Rt\n");              break;
    case AV_DOWNMIX_TYPE_DPLII:   av_log(ctx, AV_LOG_INFO, "Dolby Pro Logic II\n"); break;
    default:                      av_log(ctx, AV_LOG_WARNING, "invalid data");     return;
    }
 
    for (int i = 0; i < downmix_type_map[dm->downmix_type]; i++) {
        av_log(ctx, AV_LOG_INFO, "[%s] = { ", i ? "FR" : "FL");
        for (int j = 0; j < dm->in_ch_count; j++) {
            av_channel_name(buf, sizeof(buf), av_channel_layout_channel_from_index(ch_layout, j));
            av_log(ctx, AV_LOG_INFO, ".%s = %f, ", buf, *av_downmix_matrix_coeff(dm, i, j));
        }
        av_log(ctx, AV_LOG_INFO, "}%s", i == downmix_type_map[dm->downmix_type] - 1 ? "" : ",\n");
    }
}
 
static void print_gain(AVFilterContext *ctx, const char *str, int32_t gain)
{
    av_log(ctx, AV_LOG_INFO, "%s - ", str);
    if (gain == INT32_MIN)
        av_log(ctx, AV_LOG_INFO, "unknown");
    else
        av_log(ctx, AV_LOG_INFO, "%f", gain / 100000.0f);
    av_log(ctx, AV_LOG_INFO, ", ");
}
 
static void print_peak(AVFilterContext *ctx, const char *str, uint32_t peak)
{
    av_log(ctx, AV_LOG_INFO, "%s - ", str);
    if (!peak)
        av_log(ctx, AV_LOG_INFO, "unknown");
    else
        av_log(ctx, AV_LOG_INFO, "%f", peak / 100000.0f);
    av_log(ctx, AV_LOG_INFO, ", ");
}
 
static void dump_replaygain(AVFilterContext *ctx, AVFrameSideData *sd)
{
    AVReplayGain *rg;
 
    av_log(ctx, AV_LOG_INFO, "replaygain: ");
    if (sd->size < sizeof(*rg)) {
        av_log(ctx, AV_LOG_INFO, "invalid data");
        return;
    }
    rg = (AVReplayGain*)sd->data;
 
    print_gain(ctx, "track gain", rg->track_gain);
    print_peak(ctx, "track peak", rg->track_peak);
    print_gain(ctx, "album gain", rg->album_gain);
    print_peak(ctx, "album peak", rg->album_peak);
}
 
static void dump_audio_service_type(AVFilterContext *ctx, AVFrameSideData *sd)
{
    enum AVAudioServiceType *ast;
 
    av_log(ctx, AV_LOG_INFO, "audio service type: ");
    if (sd->size < sizeof(*ast)) {
        av_log(ctx, AV_LOG_INFO, "invalid data");
        return;
    }
    ast = (enum AVAudioServiceType*)sd->data;
    switch (*ast) {
    case AV_AUDIO_SERVICE_TYPE_MAIN:              av_log(ctx, AV_LOG_INFO, "Main Audio Service"); break;
    case AV_AUDIO_SERVICE_TYPE_EFFECTS:           av_log(ctx, AV_LOG_INFO, "Effects");            break;
    case AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED: av_log(ctx, AV_LOG_INFO, "Visually Impaired");  break;
    case AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED:  av_log(ctx, AV_LOG_INFO, "Hearing Impaired");   break;
    case AV_AUDIO_SERVICE_TYPE_DIALOGUE:          av_log(ctx, AV_LOG_INFO, "Dialogue");           break;
    case AV_AUDIO_SERVICE_TYPE_COMMENTARY:        av_log(ctx, AV_LOG_INFO, "Commentary");         break;
    case AV_AUDIO_SERVICE_TYPE_EMERGENCY:         av_log(ctx, AV_LOG_INFO, "Emergency");          break;
    case AV_AUDIO_SERVICE_TYPE_VOICE_OVER:        av_log(ctx, AV_LOG_INFO, "Voice Over");         break;
    case AV_AUDIO_SERVICE_TYPE_KARAOKE:           av_log(ctx, AV_LOG_INFO, "Karaoke");            break;
    default:                                      av_log(ctx, AV_LOG_INFO, "unknown");            break;
    }
}
 
static void dump_iamf_parameter_definition(AVFilterContext *ctx, const AVFrameSideData *sd)
{
    const AVIAMFParamDefinition *param = (AVIAMFParamDefinition *)sd->data;
 
    switch (param->type) {
        case AV_IAMF_PARAMETER_DEFINITION_MIX_GAIN:
            av_log(ctx, AV_LOG_INFO, "iamf mix gain parameters: ");
            break;
        case AV_IAMF_PARAMETER_DEFINITION_DEMIXING:
            av_log(ctx, AV_LOG_INFO, "iamf demixing parameters: ");
            break;
        case AV_IAMF_PARAMETER_DEFINITION_RECON_GAIN:
            av_log(ctx, AV_LOG_INFO, "iamf recon gain parameters: ");
            break;
        default:
            av_log(ctx, AV_LOG_ERROR, "unknown iamf parameter definition type: %d",
                param->type);
            return;
    }
 
    av_log(ctx, AV_LOG_INFO,
        "nb_subblocks=%d, "
        "parameter_id=%d, "
        "parameter_rate=%d, "
        "duration=%d, "
        "constant_subblock_duration=%d,",
        param->nb_subblocks,
        param->parameter_id,
        param->parameter_rate,
        param->duration,
        param->constant_subblock_duration
    );
 
    for (unsigned i = 0; i < param->nb_subblocks; i++) {
        const void *subblock = av_iamf_param_definition_get_subblock(param, i);
 
        av_log(ctx, AV_LOG_INFO, " subblock[%d]={ ", i);
        switch (param->type) {
            case AV_IAMF_PARAMETER_DEFINITION_MIX_GAIN: {
                const AVIAMFMixGain *mix = subblock;
                av_log(ctx, AV_LOG_INFO,
                    "subblock_duration=%d, "
                    "animation_type=%d, "
                    "start_point_value=%d/%d, "
                    "end_point_value=%d/%d, "
                    "control_point_value=%d/%d, "
                    "control_point_relative_time=%d/%d",
                    mix->subblock_duration,
                    mix->animation_type,
                    mix->start_point_value.num, mix->start_point_value.den,
                    mix->end_point_value.num, mix->end_point_value.den,
                    mix->control_point_value.num, mix->control_point_value.den,
                    mix->control_point_relative_time.num, mix->control_point_relative_time.den
                );
                break;
            }
            case AV_IAMF_PARAMETER_DEFINITION_DEMIXING: {
                const AVIAMFDemixingInfo *demix = subblock;
                av_log(ctx, AV_LOG_INFO,
                    "subblock_duration=%d, "
                    "dmixp_mode=%d",
                    demix->subblock_duration,
                    demix->dmixp_mode
                );
                break;
            }
            case AV_IAMF_PARAMETER_DEFINITION_RECON_GAIN: {
                const AVIAMFReconGain *recon = subblock;
                av_log(ctx, AV_LOG_INFO,
                    "subblock_duration=%d", recon->subblock_duration
                );
                break;
            }
        }
        av_log(ctx, AV_LOG_INFO, (i == param->nb_subblocks - 1) ? " }" : " },");
    }
 
}
 
static void dump_unknown(AVFilterContext *ctx, AVFrameSideData *sd)
{
    av_log(ctx, AV_LOG_INFO, "unknown side data type: %d, size "
           "%zu bytes", sd->type, sd->size);
}
 
static int filter_frame(AVFilterLink *inlink, AVFrame *buf)
{
    FilterLink      *inl = ff_filter_link(inlink);
    AVFilterContext *ctx = inlink->dst;
    AShowInfoContext *s  = ctx->priv;
    char chlayout_str[128];
    uint32_t checksum = 0;
    int channels    = inlink->ch_layout.nb_channels;
    int planar      = av_sample_fmt_is_planar(buf->format);
    int block_align = av_get_bytes_per_sample(buf->format) * (planar ? 1 : channels);
    int data_size   = buf->nb_samples * block_align;
    int planes      = planar ? channels : 1;
    int i;
    void *tmp_ptr = av_realloc_array(s->plane_checksums, channels, sizeof(*s->plane_checksums));
 
    if (!tmp_ptr)
        return AVERROR(ENOMEM);
    s->plane_checksums = tmp_ptr;
 
    for (i = 0; i < planes; i++) {
        uint8_t *data = buf->extended_data[i];
 
        s->plane_checksums[i] = av_adler32_update(0, data, data_size);
        checksum = i ? av_adler32_update(checksum, data, data_size) :
                       s->plane_checksums[0];
    }
 
    av_channel_layout_describe(&buf->ch_layout, chlayout_str, sizeof(chlayout_str));
 
    av_log(ctx, AV_LOG_INFO,
           "n:%"PRId64" pts:%s pts_time:%s "
           "fmt:%s channels:%d chlayout:%s rate:%d nb_samples:%d "
           "checksum:%08"PRIX32" ",
           inl->frame_count_out,
           av_ts2str(buf->pts), av_ts2timestr(buf->pts, &inlink->time_base),
           av_get_sample_fmt_name(buf->format), buf->ch_layout.nb_channels, chlayout_str,
           buf->sample_rate, buf->nb_samples,
           checksum);
 
    av_log(ctx, AV_LOG_INFO, "plane_checksums: [ ");
    for (i = 0; i < planes; i++)
        av_log(ctx, AV_LOG_INFO, "%08"PRIX32" ", s->plane_checksums[i]);
    av_log(ctx, AV_LOG_INFO, "]\n");
 
    for (i = 0; i < buf->nb_side_data; i++) {
        AVFrameSideData *sd = buf->side_data[i];
 
        av_log(ctx, AV_LOG_INFO, "  side data - ");
        switch (sd->type) {
        case AV_FRAME_DATA_MATRIXENCODING: dump_matrixenc (ctx, sd); break;
        case AV_FRAME_DATA_DOWNMIX_INFO:   dump_downmix   (ctx, sd); break;
        case AV_FRAME_DATA_DOWNMIX_MATRIX: dump_downmix_matrix(ctx, sd, &buf->ch_layout); break;
        case AV_FRAME_DATA_REPLAYGAIN:     dump_replaygain(ctx, sd); break;
        case AV_FRAME_DATA_AUDIO_SERVICE_TYPE: dump_audio_service_type(ctx, sd); break;
        case AV_FRAME_DATA_IAMF_DEMIXING_INFO_PARAM:
        case AV_FRAME_DATA_IAMF_MIX_GAIN_PARAM:
        case AV_FRAME_DATA_IAMF_RECON_GAIN_INFO_PARAM:
            dump_iamf_parameter_definition(ctx, sd);
            break;
        default:                           dump_unknown   (ctx, sd); break;
        }
 
        av_log(ctx, AV_LOG_INFO, "\n");
    }
 
    return ff_filter_frame(inlink->dst->outputs[0], buf);
}
 
static const AVFilterPad inputs[] = {
    {
        .name         = "default",
        .type         = AVMEDIA_TYPE_AUDIO,
        .filter_frame = filter_frame,
    },
};
 
const FFFilter ff_af_ashowinfo = {
    .p.name        = "ashowinfo",
    .p.description = NULL_IF_CONFIG_SMALL("Show textual information for each audio frame."),
    .p.flags       = AVFILTER_FLAG_METADATA_ONLY,
    .priv_size   = sizeof(AShowInfoContext),
    .uninit      = uninit,
    FILTER_INPUTS(inputs),
    FILTER_OUTPUTS(ff_audio_default_filterpad),
};