export_formats.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2010 Sakari Bergen <sakari.bergen@beatwaves.net>
 * Copyright (C) 2008-2015 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2009-2011 David Robillard <d@drobilla.net>
 * Copyright (C) 2018-2019 Robin Gareus <robin@gareus.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <list>
#include <memory>
 
#include "pbd/failed_constructor.h"
#include "pbd/signals.h"
 
#include "ardour/export_format_base.h"
#include "ardour/export_format_compatibility.h"
 
namespace ARDOUR {
 
class LIBARDOUR_API ExportFormatIncompatible : public failed_constructor
{
public:
        virtual const char* what () const throw ()
        {
                return "Export format constructor failed: Format incompatible with system";
        }
};
 
class LIBARDOUR_API ExportFormat : public ExportFormatBase, public ExportFormatBase::SelectableCompatible
{
public:
        ExportFormat (){};
        ~ExportFormat (){};
 
        virtual bool set_compatibility_state (ExportFormatCompatibility const& compatibility) = 0;
 
        virtual Type get_type () const = 0;
 
        FormatId get_format_id () const
        {
                return *format_ids.begin ();
        }
 
        Quality get_quality () const
        {
                return *qualities.begin ();
        }
 
        bool has_sample_format ();
        bool has_codec_quality ();
 
        bool sample_format_is_compatible (SampleFormat format) const;
 
        /* If the format has a specific sample format, this function should be overridden
         * if the format has a selectable sample format, do not override this!
         */
        virtual SampleFormat get_explicit_sample_format () const
        {
                return SF_None;
        }
 
        /* If the above is not overridden, this one should be */
        virtual ExportFormat::SampleFormat default_sample_format () const
        {
                return SF_None;
        }
 
        /* If the format has a channel count limit, override this */
        virtual uint32_t get_channel_limit () const
        {
                return 256;
        }
 
        /* If the format can be tagged with metadata override this */
        virtual bool supports_tagging () const
        {
                return false;
        }
 
        /* If the format contains broadcast info override this */
        virtual bool has_broadcast_info () const
        {
                return false;
        }
 
protected:
        void add_sample_rate (SampleRate rate)
        {
                sample_rates.insert (rate);
        }
 
        void add_endianness (Endianness endianness)
        {
                endiannesses.insert (endianness);
        }
 
        void set_format_id (FormatId id)
        {
                format_ids.clear ();
                format_ids.insert (id);
        }
 
        void set_quality (Quality value)
        {
                qualities.clear ();
                qualities.insert (value);
        }
};
 
class LIBARDOUR_API HasCodecQuality
{
public:
        struct CodecQuality {
                CodecQuality (std::string const& n, int q)
                        : name (n)
                        , quality (q)
                {}
 
                std::string name;
                int         quality;
        };
 
        typedef std::shared_ptr<CodecQuality> CodecQualityPtr;
        typedef std::list<CodecQualityPtr>      CodecQualityList;
 
        virtual ~HasCodecQuality () {}
 
        void add_codec_quality (std::string const& name, int q)
        {
                CodecQualityPtr ptr (new CodecQuality (name, q));
                _codec_qualties.push_back (ptr);
        }
 
        CodecQualityList const& get_codec_qualities () const
        {
                return _codec_qualties;
        }
 
        virtual int default_codec_quality () const = 0;
 
protected:
        CodecQualityList _codec_qualties;
};
 
class LIBARDOUR_API HasSampleFormat : public PBD::ScopedConnectionList
{
public:
        class SampleFormatState : public ExportFormatBase::SelectableCompatible
        {
        public:
                SampleFormatState (ExportFormatBase::SampleFormat format, std::string name)
                        : format (format)
                {
                        set_name (name);
                }
 
                ExportFormatBase::SampleFormat format;
        };
 
        class DitherTypeState : public ExportFormatBase::SelectableCompatible
        {
        public:
                DitherTypeState (ExportFormatBase::DitherType type, Glib::ustring name)
                        : type (type)
                {
                        set_name (name);
                }
 
                ExportFormatBase::DitherType type;
        };
 
        typedef std::shared_ptr<SampleFormatState> SampleFormatPtr;
        typedef std::weak_ptr<SampleFormatState>   WeakSampleFormatPtr;
        typedef std::list<SampleFormatPtr>           SampleFormatList;
 
        typedef std::shared_ptr<DitherTypeState> DitherTypePtr;
        typedef std::weak_ptr<DitherTypeState>   WeakDitherTypePtr;
        typedef std::list<DitherTypePtr>           DitherTypeList;
 
public:
        HasSampleFormat (ExportFormatBase::SampleFormatSet& sample_formats);
        virtual ~HasSampleFormat (){};
 
        void add_sample_format (ExportFormatBase::SampleFormat format);
 
        SampleFormatList const& get_sample_formats () const
        {
                return sample_format_states;
        }
 
        DitherTypeList const& get_dither_types () const
        {
                return dither_type_states;
        }
 
        SampleFormatPtr get_selected_sample_format ();
        DitherTypePtr   get_selected_dither_type ();
 
        /* Proxies for signals from sample formats and dither types */
        PBD::Signal<void(bool, WeakSampleFormatPtr)> SampleFormatSelectChanged;
        PBD::Signal<void(bool, WeakSampleFormatPtr)> SampleFormatCompatibleChanged;
 
        PBD::Signal<void(bool, WeakDitherTypePtr)> DitherTypeSelectChanged;
        PBD::Signal<void(bool, WeakDitherTypePtr)> DitherTypeCompatibleChanged;
 
        static std::string get_sample_format_name (ExportFormatBase::SampleFormat format);
 
protected:
        /* State lists */
        DitherTypeList   dither_type_states;
        SampleFormatList sample_format_states;
 
private:
        /* Connected to signals */
        void add_dither_type (ExportFormatBase::DitherType type, std::string name);
        void update_sample_format_selection (bool);
        void update_dither_type_selection (bool);
 
        /* Reference to ExportFormatBase::sample_formats */
        ExportFormatBase::SampleFormatSet& _sample_formats;
};
 
class LIBARDOUR_API ExportFormatLinear : public ExportFormat, public HasSampleFormat
{
public:
        ExportFormatLinear (std::string name, FormatId format_id);
        ~ExportFormatLinear (){};
 
        bool set_compatibility_state (ExportFormatCompatibility const& compatibility);
        Type get_type () const
        {
                return T_Sndfile;
        }
 
        void add_endianness (Endianness endianness)
        {
                endiannesses.insert (endianness);
        }
 
        void set_default_sample_format (SampleFormat sf)
        {
                _default_sample_format = sf;
        }
 
        SampleFormat default_sample_format () const
        {
                return _default_sample_format;
        }
 
protected:
        SampleFormat _default_sample_format;
};
 
class LIBARDOUR_API ExportFormatTaggedLinear : public ExportFormatLinear
{
public:
        ExportFormatTaggedLinear (std::string name, FormatId format_id)
                : ExportFormatLinear (name, format_id)
        {
        }
 
        virtual bool supports_tagging () const
        {
                return true;
        }
};
 
class LIBARDOUR_API ExportFormatOggVorbis : public ExportFormat, public HasCodecQuality
{
public:
        ExportFormatOggVorbis ();
        ~ExportFormatOggVorbis (){};
 
        bool set_compatibility_state (ExportFormatCompatibility const& compatibility);
        Type get_type () const
        {
                return T_Sndfile;
        }
        SampleFormat get_explicit_sample_format () const
        {
                return SF_Vorbis;
        }
        virtual bool supports_tagging () const
        {
                return true;
        }
        int default_codec_quality () const
        {
                return 40;
        }
};
 
class LIBARDOUR_API ExportFormatFLAC : public ExportFormat, public HasSampleFormat
{
public:
        ExportFormatFLAC ();
        ~ExportFormatFLAC (){};
 
        bool set_compatibility_state (ExportFormatCompatibility const& compatibility);
        Type get_type () const
        {
                return T_Sndfile;
        }
        uint32_t get_channel_limit () const
        {
                return 8;
        }
        SampleFormat default_sample_format () const
        {
                return SF_16;
        }
        virtual bool supports_tagging () const
        {
                return true;
        }
};
 
class LIBARDOUR_API ExportFormatBWF : public ExportFormat, public HasSampleFormat
{
public:
        ExportFormatBWF ();
        ~ExportFormatBWF (){};
 
        bool set_compatibility_state (ExportFormatCompatibility const& compatibility);
 
        Type get_type () const
        {
                return T_Sndfile;
        }
        SampleFormat default_sample_format () const
        {
                return SF_16;
        }
        virtual bool has_broadcast_info () const
        {
                return true;
        }
};
 
class LIBARDOUR_API ExportFormatOggOpus : public ExportFormat, public HasCodecQuality
{
public:
        ExportFormatOggOpus ();
        ~ExportFormatOggOpus (){};
 
        bool set_compatibility_state (ExportFormatCompatibility const& compatibility);
 
        Type get_type () const
        {
                return T_Sndfile;
        }
        SampleFormat get_explicit_sample_format () const
        {
                return SF_Opus;
        }
        int default_codec_quality () const
        {
                return 49;
        }
        virtual bool supports_tagging () const
        {
                return true;
        }
};
 
class LIBARDOUR_API ExportFormatMPEG : public ExportFormat, public HasSampleFormat, public HasCodecQuality
{
public:
        ExportFormatMPEG (std::string const& name, std::string const& ext);
        ~ExportFormatMPEG (){};
 
        bool set_compatibility_state (ExportFormatCompatibility const& compatibility);
 
        Type get_type () const
        {
                return T_Sndfile;
        }
        SampleFormat default_sample_format () const
        {
                return SF_MPEG_LAYER_III;
        }
        int default_codec_quality () const
        {
                return 40;
        }
        virtual bool supports_tagging () const
        {
                return true;
        }
};
 
class LIBARDOUR_API ExportFormatFFMPEG : public ExportFormat, public HasCodecQuality
{
public:
        ExportFormatFFMPEG (std::string const& name, std::string const& ext);
        ~ExportFormatFFMPEG (){};
 
        bool set_compatibility_state (ExportFormatCompatibility const& compatibility);
 
        Type get_type () const
        {
                return T_FFMPEG;
        }
        SampleFormat get_explicit_sample_format () const
        {
                return SF_Float;
        }
        int default_codec_quality () const
        {
                return -2;
        }
        virtual bool supports_tagging () const
        {
                return true;
        }
};
 
} // namespace ARDOUR